Skip to content

Document and test forwarding of agent-specific startup args#67

Merged
nezhar merged 1 commit intomainfrom
issue-64
Apr 22, 2026
Merged

Document and test forwarding of agent-specific startup args#67
nezhar merged 1 commit intomainfrom
issue-64

Conversation

@nezhar
Copy link
Copy Markdown
Collaborator

@nezhar nezhar commented Apr 22, 2026 •
edited by coderabbitai Bot
Loading

Improves the documentation and testing around how extra arguments are forwarded to agent commands in vp run, clarifying the use of -- to separate VibePod options from agent-specific flags. It also adds and updates tests to ensure correct argument forwarding behavior.

Documentation improvements:

  • Updated README.md, docs/agents/index.md, and docs/quickstart.md to clarify that extra arguments after the agent name are forwarded to the agent process, and to explain the use of -- to separate VibePod options from agent flags.
  • Improved the docstring in src/vibepod/commands/run.py to explain the correct usage of -- for agent flags.

Testing improvements:

  • Added a new test in tests/test_cli.py to verify that extra option arguments after -- are forwarded correctly to the agent.
  • Added a new test in tests/test_run.py to ensure extra arguments after -- are appended to the agent command as expected.
  • Imported CliRunner from typer.testing in tests/test_run.py to support the new test.

Summary by CodeRabbit

  • Documentation

    • Expanded README and guides with instructions on forwarding CLI arguments to agents using the -- separator syntax to prevent argument parsing conflicts.

  • Tests

    • Added integration tests validating that agent-specific arguments are correctly forwarded after the separator delimiter.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 22, 2026 •
edited
Loading

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6ff90562-ff04-47f5-96e6-a0f14af5abee

📥 Commits

Reviewing files that changed from the base of the PR and between d649689 and 12fc1b6.

📒 Files selected for processing (6)
  • README.md
  • docs/agents/index.md
  • docs/quickstart.md
  • src/vibepod/commands/run.py
  • tests/test_cli.py
  • tests/test_run.py
📝 Walkthrough

Walkthrough

This PR adds documentation and tests for passing CLI arguments to underlying agent processes in VibePod. It documents the -- delimiter syntax used to forward arguments to agents without VibePod parsing them as its own options, and includes integration tests verifying the passthrough behavior.

Changes

Cohort / File(s) Summary
Documentation updates
README.md, docs/agents/index.md, docs/quickstart.md		 Added new sections documenting how to forward CLI arguments to agent processes using the vp run <agent> -- <agent-args> syntax, with examples and notes about consulting agent-specific CLI help.
Docstring update
src/vibepod/commands/run.py		 Updated the run command's docstring to include guidance on using -- before agent flags to prevent VibePod from parsing them as its own options.
CLI integration tests
tests/test_cli.py, tests/test_run.py		 Added new test functions verifying that CLI arguments after the -- delimiter are correctly forwarded to the agent command, with assertions on exit codes and passthrough argument capture.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~18 minutes

Possibly related PRs

Poem

🐰 The arguments now flow, past the double-dash gate,
Where agents command in their container's own state,
No parsing collisions, no flags led astray,
Tests verify the path, docs light up the way! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 25.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The pull request title accurately summarizes the main change: documentation and testing updates for agent argument forwarding, which is reflected across all modified files.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch issue-64

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@nezhar nezhar linked an issue Apr 22, 2026 that may be closed by this pull request
Allow passing additional positional CLI args to the agent CLI used for the run #64
Closed
@augmentcode
Copy link
Copy Markdown

augmentcode Bot commented Apr 22, 2026

🤖 Augment PR Summary

Summary: This PR clarifies and verifies how vp run forwards agent-specific arguments.

Changes:

  • Docs: Updated README and user docs to explain that trailing args after the agent name are forwarded, and that `--` should be used to prevent VibePod option parsing for agent flags.
  • Code: Expanded the `run()` docstring to document `--` usage for agent flags.
  • Tests: Added coverage to ensure agent aliases forward args after a `--` delimiter.
  • Tests: Added a CLI-level test confirming args after `--` are appended to the container command passed to `DockerManager.run_agent`.

Technical Notes: The behavior relies on Typer/Click allow_extra_args + ignore_unknown_options and reading passthrough args from click.get_current_context().args.

🤖 Was this summary useful? React with 👍 or 👎

augmentcode[bot]
augmentcode Bot reviewed Apr 22, 2026
View reviewed changes
Copy link
Copy Markdown

@augmentcode augmentcode Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review completed. No suggestions at this time.

Comment augment review to trigger a new review at any time.

@nezhar nezhar merged commit c9ae95d into main Apr 22, 2026
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@augmentcode augmentcode[bot] augmentcode[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Allow passing additional positional CLI args to the agent CLI used for the run

1 participant

@nezhar